home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 2000 October: Mac OS SDK / Dev.CD Oct 00 SDK1.toast / Development Kits / Cross Platform / QuickTime 4.1.2 Windows SDK / CIncludes / UnicodeConverter.h < prev    next >
Encoding:
C/C++ Source or Header  |  2000-04-12  |  14.9 KB  |  421 lines  |  [TEXT/R*ch]
  1. /*
  2.      File:        UnicodeConverter.h
  3.  
  4.      Contains:    Types, constants, and prototypes for Unicode Converter
  5.  
  6.      Version:    Technology:    Mac OS 9.0
  7.                  Release:    QuickTime 4.1
  8.  
  9.      Copyright:    (c) 1994-1999 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __UNICODECONVERTER__
  18. #define __UNICODECONVERTER__
  19.  
  20. #ifndef __MACTYPES__
  21.     #include <MacTypes.h>
  22. #endif
  23.  
  24. #ifndef __TEXTCOMMON__
  25.     #include <TextCommon.h>
  26. #endif
  27.  
  28. #ifndef __MIXEDMODE__
  29.     #include <MixedMode.h>
  30. #endif
  31.  
  32.  
  33.  
  34.  
  35. #if PRAGMA_ONCE
  36. #pragma once
  37. #endif
  38.  
  39. #ifdef __cplusplus
  40. extern "C" {
  41. #endif
  42.  
  43. #if PRAGMA_IMPORT
  44. #pragma import on
  45. #endif
  46.  
  47. #if PRAGMA_STRUCT_ALIGN
  48.     #pragma options align=mac68k
  49. #elif PRAGMA_STRUCT_PACKPUSH
  50.     #pragma pack(push, 2)
  51. #elif PRAGMA_STRUCT_PACK
  52.     #pragma pack(2)
  53. #endif
  54.  
  55. /* Unicode conversion contexts: */
  56. typedef struct OpaqueTextToUnicodeInfo*  TextToUnicodeInfo;
  57. typedef struct OpaqueUnicodeToTextInfo*  UnicodeToTextInfo;
  58. typedef struct OpaqueUnicodeToTextRunInfo*  UnicodeToTextRunInfo;
  59. typedef const TextToUnicodeInfo         ConstTextToUnicodeInfo;
  60. typedef const UnicodeToTextInfo         ConstUnicodeToTextInfo;
  61. /* UnicodeMapVersion type & values */
  62. typedef SInt32                             UnicodeMapVersion;
  63. enum {
  64.     kUnicodeUseLatestMapping    = -1,
  65.     kUnicodeUseHFSPlusMapping    = 4
  66. };
  67.  
  68. /* Types used in conversion */
  69.  
  70. struct UnicodeMapping {
  71.     TextEncoding                     unicodeEncoding;
  72.     TextEncoding                     otherEncoding;
  73.     UnicodeMapVersion                 mappingVersion;
  74. };
  75. typedef struct UnicodeMapping            UnicodeMapping;
  76. typedef UnicodeMapping *                UnicodeMappingPtr;
  77.  
  78. typedef const UnicodeMapping *            ConstUnicodeMappingPtr;
  79. /* Control flags for ConvertFromUnicodeToText and ConvertFromTextToUnicode */
  80. enum {
  81.     kUnicodeUseFallbacksBit        = 0,
  82.     kUnicodeKeepInfoBit            = 1,
  83.     kUnicodeDirectionalityBits    = 2,
  84.     kUnicodeVerticalFormBit        = 4,
  85.     kUnicodeLooseMappingsBit    = 5,
  86.     kUnicodeStringUnterminatedBit = 6,
  87.     kUnicodeTextRunBit            = 7,
  88.     kUnicodeKeepSameEncodingBit    = 8,
  89.     kUnicodeForceASCIIRangeBit    = 9,
  90.     kUnicodeNoHalfwidthCharsBit    = 10,
  91.     kUnicodeTextRunHeuristicsBit = 11
  92. };
  93.  
  94. enum {
  95.     kUnicodeUseFallbacksMask    = 1L << kUnicodeUseFallbacksBit,
  96.     kUnicodeKeepInfoMask        = 1L << kUnicodeKeepInfoBit,
  97.     kUnicodeDirectionalityMask    = 3L << kUnicodeDirectionalityBits,
  98.     kUnicodeVerticalFormMask    = 1L << kUnicodeVerticalFormBit,
  99.     kUnicodeLooseMappingsMask    = 1L << kUnicodeLooseMappingsBit,
  100.     kUnicodeStringUnterminatedMask = 1L << kUnicodeStringUnterminatedBit,
  101.     kUnicodeTextRunMask            = 1L << kUnicodeTextRunBit,
  102.     kUnicodeKeepSameEncodingMask = 1L << kUnicodeKeepSameEncodingBit,
  103.     kUnicodeForceASCIIRangeMask    = 1L << kUnicodeForceASCIIRangeBit,
  104.     kUnicodeNoHalfwidthCharsMask = 1L << kUnicodeNoHalfwidthCharsBit,
  105.     kUnicodeTextRunHeuristicsMask = 1L << kUnicodeTextRunHeuristicsBit
  106. };
  107.  
  108. /* Values for kUnicodeDirectionality field */
  109. enum {
  110.     kUnicodeDefaultDirection    = 0,
  111.     kUnicodeLeftToRight            = 1,
  112.     kUnicodeRightToLeft            = 2
  113. };
  114.  
  115. /* Directionality masks for control flags */
  116. enum {
  117.     kUnicodeDefaultDirectionMask = kUnicodeDefaultDirection << kUnicodeDirectionalityBits,
  118.     kUnicodeLeftToRightMask        = kUnicodeLeftToRight << kUnicodeDirectionalityBits,
  119.     kUnicodeRightToLeftMask        = kUnicodeRightToLeft << kUnicodeDirectionalityBits
  120. };
  121.  
  122.  
  123. /* Control flags for TruncateForUnicodeToText: */
  124. /*
  125.    Now TruncateForUnicodeToText uses control flags from the same set as used by
  126.    ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc., but only
  127.    kUnicodeStringUnterminatedMask is meaningful for TruncateForUnicodeToText.
  128.    
  129.    Previously two special control flags were defined for TruncateForUnicodeToText:
  130.           kUnicodeTextElementSafeBit = 0
  131.           kUnicodeRestartSafeBit = 1
  132.    However, neither of these was implemented.
  133.    Instead of implementing kUnicodeTextElementSafeBit, we now use
  134.    kUnicodeStringUnterminatedMask since it accomplishes the same thing and avoids
  135.    having special flags just for TruncateForUnicodeToText
  136.    Also, kUnicodeRestartSafeBit is unnecessary, since restart-safeness is handled by
  137.    setting kUnicodeKeepInfoBit with ConvertFromUnicodeToText.
  138.    If TruncateForUnicodeToText is called with one or both of the old special control
  139.    flags set (bits 0 or 1), it will not generate a paramErr, but the old bits have no
  140.    effect on its operation.
  141. */
  142.  
  143. /* Filter bits for filter field in QueryUnicodeMappings and CountUnicodeMappings: */
  144. enum {
  145.     kUnicodeMatchUnicodeBaseBit    = 0,
  146.     kUnicodeMatchUnicodeVariantBit = 1,
  147.     kUnicodeMatchUnicodeFormatBit = 2,
  148.     kUnicodeMatchOtherBaseBit    = 3,
  149.     kUnicodeMatchOtherVariantBit = 4,
  150.     kUnicodeMatchOtherFormatBit    = 5
  151. };
  152.  
  153. enum {
  154.     kUnicodeMatchUnicodeBaseMask = 1L << kUnicodeMatchUnicodeBaseBit,
  155.     kUnicodeMatchUnicodeVariantMask = 1L << kUnicodeMatchUnicodeVariantBit,
  156.     kUnicodeMatchUnicodeFormatMask = 1L << kUnicodeMatchUnicodeFormatBit,
  157.     kUnicodeMatchOtherBaseMask    = 1L << kUnicodeMatchOtherBaseBit,
  158.     kUnicodeMatchOtherVariantMask = 1L << kUnicodeMatchOtherVariantBit,
  159.     kUnicodeMatchOtherFormatMask = 1L << kUnicodeMatchOtherFormatBit
  160. };
  161.  
  162. /* Control flags for SetFallbackUnicodeToText */
  163. enum {
  164.     kUnicodeFallbackSequencingBits = 0
  165. };
  166.  
  167. enum {
  168.     kUnicodeFallbackSequencingMask = 3L << kUnicodeFallbackSequencingBits,
  169.     kUnicodeFallbackInterruptSafeMask = 1L << 2                    /* To indicate that caller fallback routine doesn't move memory*/
  170. };
  171.  
  172. /* values for kUnicodeFallbackSequencing field */
  173. enum {
  174.     kUnicodeFallbackDefaultOnly    = 0L,
  175.     kUnicodeFallbackCustomOnly    = 1L,
  176.     kUnicodeFallbackDefaultFirst = 2L,
  177.     kUnicodeFallbackCustomFirst    = 3L
  178. };
  179.  
  180.  
  181. /* Caller-supplied entry point to a fallback handler */
  182. typedef CALLBACK_API( OSStatus , UnicodeToTextFallbackProcPtr )(UniChar *iSrcUniStr, ByteCount iSrcUniStrLen, ByteCount *oSrcConvLen, TextPtr oDestStr, ByteCount iDestStrLen, ByteCount *oDestConvLen, LogicalAddress iInfoPtr, ConstUnicodeMappingPtr iUnicodeMappingPtr);
  183. typedef STACK_UPP_TYPE(UnicodeToTextFallbackProcPtr)             UnicodeToTextFallbackUPP;
  184. #if OPAQUE_UPP_TYPES
  185.     EXTERN_API(UnicodeToTextFallbackUPP)
  186.     NewUnicodeToTextFallbackUPP       (UnicodeToTextFallbackProcPtr userRoutine);
  187.  
  188.     EXTERN_API(void)
  189.     DisposeUnicodeToTextFallbackUPP    (UnicodeToTextFallbackUPP userUPP);
  190.  
  191.     EXTERN_API(OSStatus)
  192.     InvokeUnicodeToTextFallbackUPP    (UniChar *            iSrcUniStr,
  193.                                     ByteCount                iSrcUniStrLen,
  194.                                     ByteCount *                oSrcConvLen,
  195.                                     TextPtr                    oDestStr,
  196.                                     ByteCount                iDestStrLen,
  197.                                     ByteCount *                oDestConvLen,
  198.                                     LogicalAddress            iInfoPtr,
  199.                                     ConstUnicodeMappingPtr    iUnicodeMappingPtr,
  200.                                     UnicodeToTextFallbackUPP userUPP);
  201.  
  202. #else
  203.     enum { uppUnicodeToTextFallbackProcInfo = 0x003FFFF0 };         /* pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes) */
  204.     #define NewUnicodeToTextFallbackUPP(userRoutine)                 (UnicodeToTextFallbackUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppUnicodeToTextFallbackProcInfo, GetCurrentArchitecture())
  205.     #define DisposeUnicodeToTextFallbackUPP(userUPP)                 DisposeRoutineDescriptor(userUPP)
  206.     #define InvokeUnicodeToTextFallbackUPP(iSrcUniStr, iSrcUniStrLen, oSrcConvLen, oDestStr, iDestStrLen, oDestConvLen, iInfoPtr, iUnicodeMappingPtr, userUPP)  (OSStatus)CALL_EIGHT_PARAMETER_UPP((userUPP), uppUnicodeToTextFallbackProcInfo, (iSrcUniStr), (iSrcUniStrLen), (oSrcConvLen), (oDestStr), (iDestStrLen), (oDestConvLen), (iInfoPtr), (iUnicodeMappingPtr))
  207. #endif
  208. /* support for pre-Carbon UPP routines: NewXXXProc and CallXXXProc */
  209. #define NewUnicodeToTextFallbackProc(userRoutine)                 NewUnicodeToTextFallbackUPP(userRoutine)
  210. #define CallUnicodeToTextFallbackProc(userRoutine, iSrcUniStr, iSrcUniStrLen, oSrcConvLen, oDestStr, iDestStrLen, oDestConvLen, iInfoPtr, iUnicodeMappingPtr) InvokeUnicodeToTextFallbackUPP(iSrcUniStr, iSrcUniStrLen, oSrcConvLen, oDestStr, iDestStrLen, oDestConvLen, iInfoPtr, iUnicodeMappingPtr, userRoutine)
  211. /* Function prototypes */
  212. #if TARGET_CPU_68K && !TARGET_RT_MAC_CFM
  213. /*
  214.       Routine to Initialize the Unicode Converter and cleanup once done with it. 
  215.       These routines must be called from Static Library clients.
  216. */
  217. EXTERN_API( OSStatus )
  218. InitializeUnicodeConverter        (StringPtr                 TECFileName);
  219.  
  220. EXTERN_API( void )
  221. TerminateUnicodeConverter        (void);
  222.  
  223. /* Note: the old names (InitializeUnicode, TerminateUnicode) for the above are still exported.*/
  224. #endif  /* TARGET_CPU_68K && !TARGET_RT_MAC_CFM */
  225.  
  226. EXTERN_API( OSStatus )
  227. CreateTextToUnicodeInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  228.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  229.  
  230. EXTERN_API( OSStatus )
  231. CreateTextToUnicodeInfoByEncoding (TextEncoding         iEncoding,
  232.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  233.  
  234. EXTERN_API( OSStatus )
  235. CreateUnicodeToTextInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  236.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  237.  
  238. EXTERN_API( OSStatus )
  239. CreateUnicodeToTextInfoByEncoding (TextEncoding         iEncoding,
  240.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  241.  
  242. EXTERN_API( OSStatus )
  243. CreateUnicodeToTextRunInfo        (ItemCount                 iNumberOfMappings,
  244.                                  const UnicodeMapping     iUnicodeMappings[],
  245.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  246.  
  247. EXTERN_API( OSStatus )
  248. CreateUnicodeToTextRunInfoByEncoding (ItemCount         iNumberOfEncodings,
  249.                                  const TextEncoding     iEncodings[],
  250.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  251.  
  252. EXTERN_API( OSStatus )
  253. CreateUnicodeToTextRunInfoByScriptCode (ItemCount         iNumberOfScriptCodes,
  254.                                  const ScriptCode         iScripts[],
  255.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  256.  
  257. /* Change the TextToUnicodeInfo to another mapping. */
  258. EXTERN_API( OSStatus )
  259. ChangeTextToUnicodeInfo            (TextToUnicodeInfo         ioTextToUnicodeInfo,
  260.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  261.  
  262. /* Change the UnicodeToTextInfo to another mapping. */
  263. EXTERN_API( OSStatus )
  264. ChangeUnicodeToTextInfo            (UnicodeToTextInfo         ioUnicodeToTextInfo,
  265.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  266.  
  267.  
  268. EXTERN_API( OSStatus )
  269. DisposeTextToUnicodeInfo        (TextToUnicodeInfo *    ioTextToUnicodeInfo);
  270.  
  271. EXTERN_API( OSStatus )
  272. DisposeUnicodeToTextInfo        (UnicodeToTextInfo *    ioUnicodeToTextInfo);
  273.  
  274. EXTERN_API( OSStatus )
  275. DisposeUnicodeToTextRunInfo        (UnicodeToTextRunInfo *    ioUnicodeToTextRunInfo);
  276.  
  277. EXTERN_API( OSStatus )
  278. ConvertFromTextToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  279.                                  ByteCount                 iSourceLen,
  280.                                  ConstLogicalAddress     iSourceStr,
  281.                                  OptionBits             iControlFlags,
  282.                                  ItemCount                 iOffsetCount,
  283.                                  ByteOffset             iOffsetArray[], /* can be NULL */
  284.                                  ItemCount *            oOffsetCount, /* can be NULL */
  285.                                  ByteOffset             oOffsetArray[], /* can be NULL */
  286.                                  ByteCount                 iOutputBufLen,
  287.                                  ByteCount *            oSourceRead,
  288.                                  ByteCount *            oUnicodeLen,
  289.                                  UniCharArrayPtr         oUnicodeStr);
  290.  
  291. EXTERN_API( OSStatus )
  292. ConvertFromUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  293.                                  ByteCount                 iUnicodeLen,
  294.                                  ConstUniCharArrayPtr     iUnicodeStr,
  295.                                  OptionBits             iControlFlags,
  296.                                  ItemCount                 iOffsetCount,
  297.                                  ByteOffset             iOffsetArray[], /* can be NULL */
  298.                                  ItemCount *            oOffsetCount, /* can be NULL */
  299.                                  ByteOffset             oOffsetArray[], /* can be NULL */
  300.                                  ByteCount                 iOutputBufLen,
  301.                                  ByteCount *            oInputRead,
  302.                                  ByteCount *            oOutputLen,
  303.                                  LogicalAddress         oOutputStr);
  304.  
  305. EXTERN_API( OSStatus )
  306. ConvertFromUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextInfo,
  307.                                  ByteCount                 iUnicodeLen,
  308.                                  ConstUniCharArrayPtr     iUnicodeStr,
  309.                                  OptionBits             iControlFlags,
  310.                                  ItemCount                 iOffsetCount,
  311.                                  ByteOffset             iOffsetArray[], /* can be NULL */
  312.                                  ItemCount *            oOffsetCount, /* can be NULL */
  313.                                  ByteOffset             oOffsetArray[], /* can be NULL */
  314.                                  ByteCount                 iOutputBufLen,
  315.                                  ByteCount *            oInputRead,
  316.                                  ByteCount *            oOutputLen,
  317.                                  LogicalAddress         oOutputStr,
  318.                                  ItemCount                 iEncodingRunBufLen,
  319.                                  ItemCount *            oEncodingRunOutLen,
  320.                                  TextEncodingRun         oEncodingRuns[]);
  321.  
  322. EXTERN_API( OSStatus )
  323. ConvertFromUnicodeToScriptCodeRun (UnicodeToTextRunInfo  iUnicodeToTextInfo,
  324.                                  ByteCount                 iUnicodeLen,
  325.                                  ConstUniCharArrayPtr     iUnicodeStr,
  326.                                  OptionBits             iControlFlags,
  327.                                  ItemCount                 iOffsetCount,
  328.                                  ByteOffset             iOffsetArray[], /* can be NULL */
  329.                                  ItemCount *            oOffsetCount, /* can be NULL */
  330.                                  ByteOffset             oOffsetArray[], /* can be NULL */
  331.                                  ByteCount                 iOutputBufLen,
  332.                                  ByteCount *            oInputRead,
  333.                                  ByteCount *            oOutputLen,
  334.                                  LogicalAddress         oOutputStr,
  335.                                  ItemCount                 iScriptRunBufLen,
  336.                                  ItemCount *            oScriptRunOutLen,
  337.                                  ScriptCodeRun             oScriptCodeRuns[]);
  338.  
  339. /* Truncate a multibyte string at a safe place. */
  340. EXTERN_API( OSStatus )
  341. TruncateForTextToUnicode        (ConstTextToUnicodeInfo  iTextToUnicodeInfo,
  342.                                  ByteCount                 iSourceLen,
  343.                                  ConstLogicalAddress     iSourceStr,
  344.                                  ByteCount                 iMaxLen,
  345.                                  ByteCount *            oTruncatedLen);
  346.  
  347. /* Truncate a Unicode string at a safe place. */
  348. EXTERN_API( OSStatus )
  349. TruncateForUnicodeToText        (ConstUnicodeToTextInfo  iUnicodeToTextInfo,
  350.                                  ByteCount                 iSourceLen,
  351.                                  ConstUniCharArrayPtr     iSourceStr,
  352.                                  OptionBits             iControlFlags,
  353.                                  ByteCount                 iMaxLen,
  354.                                  ByteCount *            oTruncatedLen);
  355.  
  356. /* Convert a Pascal string to Unicode string. */
  357. EXTERN_API( OSStatus )
  358. ConvertFromPStringToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  359.                                  ConstStr255Param         iPascalStr,
  360.                                  ByteCount                 iOutputBufLen,
  361.                                  ByteCount *            oUnicodeLen,
  362.                                  UniCharArrayPtr         oUnicodeStr);
  363.  
  364. /* Convert a Unicode string to Pascal string. */
  365. EXTERN_API( OSStatus )
  366. ConvertFromUnicodeToPString        (UnicodeToTextInfo         iUnicodeToTextInfo,
  367.                                  ByteCount                 iUnicodeLen,
  368.                                  ConstUniCharArrayPtr     iUnicodeStr,
  369.                                  Str255                 oPascalStr);
  370.  
  371. /* Count the available conversion mappings. */
  372. EXTERN_API( OSStatus )
  373. CountUnicodeMappings            (OptionBits             iFilter,
  374.                                  ConstUnicodeMappingPtr  iFindMapping,
  375.                                  ItemCount *            oActualCount);
  376.  
  377. /* Get a list of the available conversion mappings. */
  378. EXTERN_API( OSStatus )
  379. QueryUnicodeMappings            (OptionBits             iFilter,
  380.                                  ConstUnicodeMappingPtr  iFindMapping,
  381.                                  ItemCount                 iMaxCount,
  382.                                  ItemCount *            oActualCount,
  383.                                  UnicodeMapping         oReturnedMappings[]);
  384.  
  385. /* Setup the fallback handler for converting Unicode To Text. */
  386. EXTERN_API( OSStatus )
  387. SetFallbackUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  388.                                  UnicodeToTextFallbackUPP  iFallback,
  389.                                  OptionBits             iControlFlags,
  390.                                  LogicalAddress         iInfoPtr);
  391.  
  392. /* Setup the fallback handler for converting Unicode To TextRuns. */
  393. EXTERN_API( OSStatus )
  394. SetFallbackUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextRunInfo,
  395.                                  UnicodeToTextFallbackUPP  iFallback,
  396.                                  OptionBits             iControlFlags,
  397.                                  LogicalAddress         iInfoPtr);
  398.  
  399.  
  400.  
  401. #if PRAGMA_STRUCT_ALIGN
  402.     #pragma options align=reset
  403. #elif PRAGMA_STRUCT_PACKPUSH
  404.     #pragma pack(pop)
  405. #elif PRAGMA_STRUCT_PACK
  406.     #pragma pack()
  407. #endif
  408.  
  409. #ifdef PRAGMA_IMPORT_OFF
  410. #pragma import off
  411. #elif PRAGMA_IMPORT
  412. #pragma import reset
  413. #endif
  414.  
  415. #ifdef __cplusplus
  416. }
  417. #endif
  418.  
  419. #endif /* __UNICODECONVERTER__ */
  420.  
  421.